Builder

Constructors

Builder

open fun Builder()

Functions

allowOverlap

open fun allowOverlap(@Nullable() allowOverlap: Boolean): ViewAnnotationOptions.Builder

If true, the annotation will be visible even if it collides with other previously drawn annotations.If allowOverlap is null, default value `false` will be applied.

anchor

open fun anchor(@Nullable() anchor: ViewAnnotationAnchor): ViewAnnotationOptions.Builder

Anchor describing where the view annotation will be located relatively to given geometry.If anchor is null, default value `CENTER` will be applied.

associatedFeatureId

open fun associatedFeatureId(@Nullable() associatedFeatureId: String): ViewAnnotationOptions.Builder

Optional style symbol id connected to given view annotation.View annotation's visibility behaviour becomes tied to feature visibility where feature could represent an icon or a text label.E.g.

build

open fun build(): ViewAnnotationOptions

geometry

open fun geometry(@Nullable() geometry: Geometry): ViewAnnotationOptions.Builder

Geometry the view annotation is bound to.

height

open fun height(@Nullable() height: Integer): ViewAnnotationOptions.Builder

View annotation height in `platform pixels`.

offsetX

open fun offsetX(@Nullable() offsetX: Integer): ViewAnnotationOptions.Builder

Extra X offset in `platform pixels`.Providing positive value moves view annotation to the right while negative moves it to the left.

offsetY

open fun offsetY(@Nullable() offsetY: Integer): ViewAnnotationOptions.Builder

Extra Y offset in `platform pixels`.Providing positive value moves view annotation to the top while negative moves it to the bottom.

selected

open fun selected(@Nullable() selected: Boolean): ViewAnnotationOptions.Builder

Specifies if this view annotation is selected meaning it should be placed on top of others.If selected in null, default value `false` will be applied.

visible

open fun visible(@Nullable() visible: Boolean): ViewAnnotationOptions.Builder

Specifies if this view annotation is visible or not.Note: For Android and iOS platforms, if this property is not specified explicitly when creating / updating view annotation, visibility will behandled automatically based on actual Android or iOS view's visibility e.g.

width

open fun width(@Nullable() width: Integer): ViewAnnotationOptions.Builder

View annotation width in `platform pixels`.